API Documentation
Thread.h
1 // Thread.h
3 //
5 
6 namespace nkTasks
7 {
11  class DLL_TASKS_EXPORT Thread final
12  {
13  public :
14 
18  Thread () ;
22  ~Thread () ;
23 
24  // Getters
27  ThreadId getThreadId () const ;
28 
29  // Setters
37  void setParentScheduler (Scheduler* value) ;
38 
55  bool cancelTask (const ThreadSubmittedWork& submittedWork) ;
56 
61  void askAbort () ;
66  void join () ;
72  void askAbortAndJoin () ;
73 
78  void run () ;
79  } ;
80 }
nkTasks::Thread
Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component.
Definition: Thread.h:12
nkTasks::ThreadSubmittedWork
Encompasses all needed information and control over a task that has been submitted.
Definition: ThreadSubmittedWork.h:12
nkTasks::Thread::join
void join()
nkTasks::Thread::addTask
ThreadSubmittedWork addTask(Task *task)
nkTasks::Thread::Thread
Thread()
nkTasks::Task
A task, job that can be submitted to a nkTasks::Thread.
Definition: Task.h:14
nkTasks::Thread::setParentScheduler
void setParentScheduler(Scheduler *value)
nkTasks
Encompasses all API of component NilkinsTasks.
Definition: LogManager.h:7
nkTasks::Thread::~Thread
~Thread()
nkTasks::Thread::askAbortAndJoin
void askAbortAndJoin()
nkTasks::Thread::cancelTask
bool cancelTask(const ThreadSubmittedWork &submittedWork)
nkTasks::Thread::askAbort
void askAbort()
nkTasks::ThreadId
std::thread::id ThreadId
Symbolizes an id for a nkTasks::Thread.
Definition: ThreadId.h:11
nkTasks::Thread::getThreadId
ThreadId getThreadId() const
nkTasks::Thread::run
void run()
nkTasks::Scheduler
Allows to automate task submission to a set of threads.
Definition: Scheduler.h:14